home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / edit / elv18src.zip / doc / elvis.doc < prev    next >
Text File  |  1994-01-17  |  8KB  |  265 lines
  1.  
  2.  
  3. NAME
  4.        elvis, ex, vi, view, input - The editor
  5.  
  6. SYNOPSIS
  7.        elvis [flags] [+cmd] [files...]
  8.  
  9. DESCRIPTION
  10.        Elvis is a text editor which emulates vi/ex.
  11.  
  12.        On  systems  which  pass  the program name as an argument,
  13.        such as Unix and Minix, you may also install  elvis  under
  14.        the  names  "ex",  "vi", "view", and "input".  These extra
  15.        names would normally be links to elvis; see the "ln" shell
  16.        command.
  17.  
  18.        When  elvis  is  invoked  as  "vi",  it behaves exactly as
  19.        though it was invoked as "elvis".  However, if you  invoke
  20.        elvis as "view", then the readonly option is set as though
  21.        you had given it the "-R" flag.  If you  invoke  elvis  as
  22.        "ex",  then  elvis will start up in the colon command mode
  23.        instead of the visual command  mode,  as  though  you  had
  24.        given it the "-e" flag.  If you invoke elvis as "input" or
  25.        "edit", then elvis will start up in input mode, as  though
  26.        the "-i" flag was given.
  27.  
  28. OPTIONS
  29.        -r     To  the  real  vi,  this flag means that a previous
  30.               edit should be recovered.   Elvis,  though,  has  a
  31.               separate  program, called elvrec(1), for recovering
  32.               files.  When you invoke elvis with -r,  elvis  will
  33.               tell you to run elvrec.
  34.  
  35.        -R     This sets the "readonly" option, so you won't acci-
  36.               dentally overwrite a file.
  37.  
  38.        -t tag This causes elvis to start  editing  at  the  given
  39.               tag.
  40.  
  41.        -m [file]
  42.               Elvis  will  search through file for something that
  43.               looks like an error message from  a  compiler.   It
  44.               will then begin editing the source file that caused
  45.               the error, with the  cursor  sitting  on  the  line
  46.               where the error was detected.  If you don't explic-
  47.               itly name a file, then "errlist" is assumed.
  48.  
  49.        -e     Elvis will start up in colon command mode.
  50.  
  51.        -v     Elvis will start up in visual command mode.
  52.  
  53.        -i     Elvis will start up in input mode.
  54.  
  55.        -w winsize
  56.               Sets the "window" option's value to winsize.
  57.  
  58.  
  59.  
  60.                                                                 1
  61.  
  62.  
  63.  
  64.  
  65.  
  66. ELVIS(1)                                                 ELVIS(1)
  67.  
  68.  
  69.        +command or -c command
  70.               If you use the +command parameter, then  after  the
  71.               first  file  is loaded command is executed as an EX
  72.               command.  A typical example would  be  "elvis  +237
  73.               foo",  which would cause elvis to start editing foo
  74.               and then move directly to line 237.  The  "-c  com-
  75.               mand"  variant  was added for UNIX SysV compatibil-
  76.               ity.
  77.  
  78. FILES
  79.        /tmp/elv*
  80.               During editing, elvis stores text  in  a  temporary
  81.               file.   For  UNIX, this file will usually be stored
  82.               in the /tmp directory, and the first three  charac-
  83.               ters  will be "elv".  For other systems, the tempo-
  84.               rary files may be stored someplace  else;  see  the
  85.               version-specific section of the documentation.
  86.  
  87.        tags   This  is the database used by the :tags command and
  88.               the -t  option.   It  is  usually  created  by  the
  89.               ctags(1) program.
  90.  
  91.        .exrc or elvis.rc
  92.               On UNIX-like systems, a file called ".exrc" in your
  93.               home directory is executed as a series of  ex  com-
  94.               mands.   A file by the same name may be executed in
  95.               the current directory, too.  On  non-UNIX  systems,
  96.               ".exrc" is usually an invalid file name; there, the
  97.               initialization file is called "elvis.rc" instead.
  98.  
  99. ENVIRONMENT
  100.        TERM   This is the name of your terminal's  entry  in  the
  101.               termcap  or  terminfo  database.  The list of legal
  102.               values varies from one system to another.
  103.  
  104.        TERMCAP
  105.               Optional.  If your system  uses  termcap,  and  the
  106.               TERMCAP variable is unset, then
  107.                will   read   your   terminal's   definition  from
  108.               /etc/termcap.  If TERMCAP is set to the full  path-
  109.               name  of  a  file  (starting with a '/') then  will
  110.               look in the named file instead of /etc/termcap.  If
  111.               TERMCAP  is set to a value which doesn't start with
  112.               a '/', then its value is assumed  to  be  the  full
  113.               termcap entry for your terminal.
  114.  
  115.        TERMINFO
  116.               Optional.   If  your  system uses terminfo, and the
  117.               TERMINFO variable is unset, then
  118.                will read  your  terminal's  definition  from  the
  119.               database  in  the  /usr/lib/terminfo  database.  If
  120.               TERMINFO is set, then its  value  is  used  as  the
  121.               database  name to use instead of /usr/lib/terminfo.
  122.  
  123.  
  124.  
  125.  
  126.                                                                 2
  127.  
  128.  
  129.  
  130.  
  131.  
  132. ELVIS(1)                                                 ELVIS(1)
  133.  
  134.  
  135.        LINES, COLUMNS
  136.               Optional.  These variables, if set,  will  override
  137.               the   screen   size   values  given  in  the  term-
  138.               cap/terminfo for your terminal.  On windowing  sys-
  139.               tems  such as X,  has other ways of determining the
  140.               screen size, so you  should  probably  leave  these
  141.               variables unset.
  142.  
  143.        EXINIT Optional.  This variable can hold EX commands which
  144.               will be executed before any .exrc files.
  145.  
  146.        SHELL  Optional.  The  SHELL  variable  sets  the  default
  147.               value  for  the  "shell"  option,  which determines
  148.               which shell program is  used  to  perform  wildcard
  149.               expansion  in file names, and also which is used to
  150.               execute filters or external programs.  The  default
  151.               value on UNIX systems is "/bin/sh".
  152.  
  153.               Note: Under MS-DOS, this variable is called COMSPEC
  154.               instead of SHELL.
  155.  
  156.        HOME   This variable should be set to  the  name  of  your
  157.               home directory.
  158.                looks  for  its initialization file there; if HOME
  159.               is unset then the initialization file will  not  be
  160.               executed.
  161.  
  162.        TAGPATH
  163.               Optional.   This variable is used by the "ref" pro-
  164.               gram, which is invoked by the  shift-K,  control-],
  165.               and :tag commands.  See "ref" for more information.
  166.  
  167.        TMP, TEMP
  168.               These optional environment variables are only  used
  169.               in non-UNIX versions of .  They allow you to supply
  170.               a directory name to be used for  storing  temporary
  171.               files.
  172.  
  173. SEE ALSO
  174.        ctags(1), ref(1), virec(1)
  175.  
  176.        Elvis  -  A  Clone of Vi/Ex, the complete elvis documenta-
  177.        tion.
  178.  
  179. BUGS
  180.        There is no LISP  support.   Certain  other  features  are
  181.        missing, too.
  182.  
  183.        Auto-indent mode is not quite compatible with the real vi.
  184.        Among other things, 0^D and ^^D don't do  what  you  might
  185.        expect.
  186.  
  187.        Long  lines  are displayed differently.  The real vi wraps
  188.        long lines onto multiple rows of  the  screen,  but  elvis
  189.  
  190.  
  191.  
  192.                                                                 3
  193.  
  194.  
  195.  
  196.  
  197.  
  198. ELVIS(1)                                                 ELVIS(1)
  199.  
  200.  
  201.        scrolls sideways.
  202.  
  203. AUTHOR
  204.        Steve Kirkendall
  205.        kirkenda@cs.pdx.edu
  206.  
  207.        Many  other  people  have  worked to port elvis to various
  208.        operating systems.  To see who deserves  credit,  run  the
  209.        :version command from within elvis, or look in the system-
  210.        specific section of the complete documentation.
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.                                                                 4
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.